home *** CD-ROM | disk | FTP | other *** search
/ Alde ADA 5 #1 / ADA CD-ROM - Alde Publishing.iso / cm / help.sid < prev    next >
Encoding:
Text File  |  1988-05-03  |  4.5 KB  |  115 lines
  1. --= SID = SIMTEL20 Ada Software Repository Item Description File = SID =--
  2. -- UNIT NAME         : HELP System
  3. -- VERSION           : 1.3
  4. -- REVIEW CODE       : 
  5. -- DDN ADDRESS       : RCONN at SIMTEL20
  6. -- AUTHOR            : Richard Conn
  7. --                   : Echelon, Inc
  8. -- COPYRIGHT         : 
  9. -- DATE CREATED      : 1 Dec 85
  10. -- DATE RELEASED     : 2 Mar 86
  11. -- DATE LAST UPDATED : 2 Mar 86
  12. -- LOCATION          : C2MUG
  13. -- LOCATION          : ASR
  14. -- ENVIRONMENT       : VAX 11/785 (VMS 4.2), DEC Ada
  15. --= CLASSIFICATION       ===============================================--
  16. -- CATEGORY LEVEL 1  : Documentation Aids
  17. -- CATEGORY LEVEL 2  : HELP System
  18. -- CATEGORY LEVEL 3  : 
  19. -- CATEGORY LEVEL 4  : 
  20. -- KEYWORD           : Online documentation
  21. -- KEYWORD           : HELP
  22. -- INDEX             : Online Documentation
  23. -- INDEX             : Documentation, Online
  24. -- INDEX             : HELP
  25. -- TAXONOMY          : 
  26. -- DEPENDENCIES      : 
  27. -- SEE ALSO          : 
  28. --= FILE LISTING         ===============================================--
  29. -- FILE SPECS        : PD:<ADA.ONLINE-DOC>HELP.*
  30. -- DIRECTORY DISPLAY :
  31. -- Directory   PD:<ADA.ONLINE-DOC>
  32. --      File Name     Byte Count  Line Count
  33. --   ---------------  ----------  ----------
  34. --   HELP.DAT             209240        6208
  35. --   HELP.EX               10538         321
  36. --   HELP.EX2               8145         243
  37. --   HELP.EX3              21666         645
  38. --   HELP.PRO               4129         101
  39. --   HELP.SRC              63360        2260
  40. --   ===============  ==========  ==========
  41. --     6 Files            317078        9778
  42. --= ABSTRACT             ===============================================--
  43. --         The HELP System is a collection of programs which  provide  an
  44. -- interactive  online  documentation facility.  Data for the facility is
  45. -- prepared as a conventional text file which is formatted in an  outline
  46. -- form, as follows:
  47. -- 
  48. --     0 Topic-Name
  49. --         <text of topic>
  50. --     1 1st-Level-Subtopic
  51. --         <text of subtopic>
  52. --     ...
  53. --     9 9th-Level-Subtopic
  54. --         <text>
  55. --     1 2nd-1st-Level-Subtopic
  56. --         <text>
  57. --     ...
  58. --     1 3rd-1st-Level-Subtopic
  59. --     ...
  60. --     0 Next-Topic
  61. --     ...
  62. -- 
  63. --         The level numbers do not have to be consecutive, and the lower
  64. -- the  level  number  is,  the higher its entry appears in the hierarchy
  65. -- (level 4 elements appear before level 6).  There may be as many topics
  66. -- at each level as desired.  A line containing only a dot (.)  character
  67. -- causes a break between screens when the help file is displayed to  the
  68. -- user:
  69. -- 
  70. --     this line appears on one screen
  71. --     .
  72. --     this line appears on the next screen (at the top)
  73. -- 
  74. --         The HELP System consists of three programs:  HELP, HELP_BUILD,
  75. -- and HELP_ANALYZE.
  76. -- 
  77. --         The HELP program is used to display information contained in a
  78. -- help  file.   This  information is in the form of a direct-access file
  79. -- created by the HELP_BUILD program.  Briefly:
  80. -- 
  81. --         text of help file 
  82. --             V
  83. --             HELP_BUILD
  84. --             V
  85. --         direct-access help file
  86. --             V
  87. --         HELP displays info to user
  88. -- 
  89. --         The HELP_ANALYZE program displays the structure hierarchy of a
  90. -- direct access file which is created by HELP_BUILD.
  91. --= REVISION HISTORY     ===============================================--
  92. --
  93. -- DATE         VERSION    AUTHOR                  HISTORY
  94. -- 31 Dec 85    1.2    Richard Conn        Production Release
  95. --  2 Mar 86    1.3     Richard Conn            Minor Revisions
  96. --= RELEASE NOTICE       ===============================================--
  97. -- This prologue must be included in all copies of this software.
  98. --
  99. -- This software is released to the Ada community.
  100. -- This software is released to the Public Domain (note:
  101. --   software released to the Public Domain is not subject
  102. --   to copyright protection).
  103. -- Restrictions on use or distribution:  NONE
  104. --= DISCLAIMER           ===============================================--
  105. --     This software and its documentation are provided "AS IS" and
  106. -- without any expressed or implied warranties whatsoever.  No warranties
  107. -- as to performance, merchantability, or fitness for a particular
  108. -- purpose exist.
  109. --     The user is advised to test the software thoroughly before
  110. -- relying on it.  The user must assume the entire risk and liability of
  111. -- using this software.  In no event shall any person or organization of
  112. -- people be held responsible for any direct, indirect, consequential or
  113. -- inconsequential damages or lost profits.
  114. --======================================================================--
  115.